Skip to content

test(docs): run the get-started page's commands - #50

Merged
HaoZeke merged 1 commit into
mainfrom
fix/walkthrough-get-started
Nov 16, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
fix/walkthrough-get-started

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

The doc walkthrough tests cover get-started.org and run its four command blocks.

  • The walkthrough checked the tutorial and the how-to, reference and explanation pages, but not get-started.org. A forbidden path in one of its bash blocks, or a quoted output the binary no longer prints, passed the suite: with --out-dir /path/to/eon-inspect in the inspect block and shards=2 in the quoted shard line, main's doc_walkthrough still passed.
  • org_files() now includes get-started.org, so its bash blocks follow the same path rules. get_started_blocks_print_what_the_page_quotes runs each block with the built binary first on PATH and /tmp moved to a temporary directory, and compares stdout with the example block that follows it. The stack admit block must exit 78 and leave its reservation directory empty, as the page says. The page itself needs no change: all four blocks print what it quotes.

The commit has a towncrier fragment. Main has no towncrier yet; #26 (fix/towncrier) adds it.

The doc walkthrough checked the tutorial and the how-to, reference and
explanation pages, but not get-started.org, the first page a site
administrator reads. A forbidden path in one of its bash blocks, or a
quoted output the binary no longer prints, passed the suite: with
--out-dir /path/to/eon-inspect in the inspect block and shards=2 in the
quoted shard line, main's doc_walkthrough still passes.

org_files() now includes get-started.org, so its bash blocks follow the
same path rules. get_started_blocks_print_what_the_page_quotes runs
each block with the built binary first on PATH and /tmp moved to a
temporary directory, and compares stdout with the example block that
follows it. The stack admit block must exit 78 and leave its
reservation directory empty, as the page says. Both checks fail on
those two edits. The page itself needs no change: all four blocks
print what it quotes.
@HaoZeke
HaoZeke merged commit 4075094 into main Nov 16, 2026
21 checks passed
@HaoZeke
HaoZeke deleted the fix/walkthrough-get-started branch November 16, 2026 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant